<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GMimeFilter: GMime 3.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GMime 3.0 Reference Manual">
<link rel="up" href="Filters.html" title="Stream Filters">
<link rel="prev" href="Filters.html" title="Stream Filters">
<link rel="next" href="GMimeFilterBasic.html" title="GMimeFilterBasic">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GMimeFilter.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GMimeFilter.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="Filters.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="Filters.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GMimeFilterBasic.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GMimeFilter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GMimeFilter.top_of_page"></a>GMimeFilter</span></h2>
<p>GMimeFilter — Abstract filter class</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GMimeFilter.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> *
</td>
<td class="function_name">
<a class="link" href="GMimeFilter.html#g-mime-filter-copy" title="g_mime_filter_copy ()">g_mime_filter_copy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GMimeFilter.html#g-mime-filter-filter" title="g_mime_filter_filter ()">g_mime_filter_filter</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GMimeFilter.html#g-mime-filter-complete" title="g_mime_filter_complete ()">g_mime_filter_complete</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GMimeFilter.html#g-mime-filter-reset" title="g_mime_filter_reset ()">g_mime_filter_reset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GMimeFilter.html#g-mime-filter-backup" title="g_mime_filter_backup ()">g_mime_filter_backup</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GMimeFilter.html#g-mime-filter-set-size" title="g_mime_filter_set_size ()">g_mime_filter_set_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GMimeFilter.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GMimeFilter.html#GMimeFilter-struct" title="struct GMimeFilter">GMimeFilter</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GMimeFilter.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GMimeFilter
        <span class="lineart">├──</span> <a class="link" href="GMimeFilterBasic.html" title="GMimeFilterBasic">GMimeFilterBasic</a>
        <span class="lineart">├──</span> <a class="link" href="GMimeFilterBest.html" title="GMimeFilterBest">GMimeFilterBest</a>
        <span class="lineart">├──</span> <a class="link" href="GMimeFilterCharset.html" title="GMimeFilterCharset">GMimeFilterCharset</a>
        <span class="lineart">├──</span> <a class="link" href="GMimeFilterChecksum.html" title="GMimeFilterChecksum">GMimeFilterChecksum</a>
        <span class="lineart">├──</span> <a class="link" href="GMimeFilterDos2Unix.html" title="GMimeFilterDos2Unix">GMimeFilterDos2Unix</a>
        <span class="lineart">├──</span> <a class="link" href="GMimeFilterEnriched.html" title="GMimeFilterEnriched">GMimeFilterEnriched</a>
        <span class="lineart">├──</span> <a class="link" href="GMimeFilterFrom.html" title="GMimeFilterFrom">GMimeFilterFrom</a>
        <span class="lineart">├──</span> <a class="link" href="GMimeFilterGZip.html" title="GMimeFilterGZip">GMimeFilterGZip</a>
        <span class="lineart">├──</span> <a class="link" href="GMimeFilterHTML.html" title="GMimeFilterHTML">GMimeFilterHTML</a>
        <span class="lineart">├──</span> <a class="link" href="GMimeFilterOpenPGP.html" title="GMimeFilterOpenPGP">GMimeFilterOpenPGP</a>
        <span class="lineart">├──</span> <a class="link" href="GMimeFilterSmtpData.html" title="GMimeFilterSmtpData">GMimeFilterSmtpData</a>
        <span class="lineart">├──</span> <a class="link" href="GMimeFilterStrip.html" title="GMimeFilterStrip">GMimeFilterStrip</a>
        <span class="lineart">├──</span> <a class="link" href="GMimeFilterUnix2Dos.html" title="GMimeFilterUnix2Dos">GMimeFilterUnix2Dos</a>
        <span class="lineart">├──</span> <a class="link" href="GMimeFilterWindows.html" title="GMimeFilterWindows">GMimeFilterWindows</a>
        <span class="lineart">╰──</span> <a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc">GMimeFilterYenc</a>
</pre>
</div>
<div class="refsect1">
<a name="GMimeFilter.description"></a><h2>Description</h2>
<p>Stream filters are an efficient way of converting data from one
format to another.</p>
</div>
<div class="refsect1">
<a name="GMimeFilter.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="g-mime-filter-copy"></a><h3>g_mime_filter_copy ()</h3>
<pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> *
g_mime_filter_copy (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>);</pre>
<p>Copies <em class="parameter"><code>filter</code></em>
 into a new <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> object.</p>
<div class="refsect3">
<a name="g-mime-filter-copy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>filter</p></td>
<td class="parameter_description"><p>filter</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-filter-copy.returns"></a><h4>Returns</h4>
<p>a duplicate of <em class="parameter"><code>filter</code></em>
. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-filter-filter"></a><h3>g_mime_filter_filter ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_filter_filter (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>,
                      <em class="parameter"><code><span class="type">char</span> *inbuf</code></em>,
                      <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>,
                      <em class="parameter"><code><span class="type">size_t</span> prespace</code></em>,
                      <em class="parameter"><code><span class="type">char</span> **outbuf</code></em>,
                      <em class="parameter"><code><span class="type">size_t</span> *outlen</code></em>,
                      <em class="parameter"><code><span class="type">size_t</span> *outprespace</code></em>);</pre>
<p>Filters the input data and writes it to <em class="parameter"><code>out</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-filter-filter.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filter</p></td>
<td class="parameter_description"><p>filter</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>inbuf</p></td>
<td class="parameter_description"><p>input buffer. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=inlen][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> guint8]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>inlen</p></td>
<td class="parameter_description"><p>input buffer length</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prespace</p></td>
<td class="parameter_description"><p>prespace buffer length</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>outbuf</p></td>
<td class="parameter_description"><p>pointer to output buffer. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=outlen][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> guint8][<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>outlen</p></td>
<td class="parameter_description"><p>pointer to output length. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>outprespace</p></td>
<td class="parameter_description"><p>pointer to output prespace buffer length. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-filter-complete"></a><h3>g_mime_filter_complete ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_filter_complete (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>,
                        <em class="parameter"><code><span class="type">char</span> *inbuf</code></em>,
                        <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>,
                        <em class="parameter"><code><span class="type">size_t</span> prespace</code></em>,
                        <em class="parameter"><code><span class="type">char</span> **outbuf</code></em>,
                        <em class="parameter"><code><span class="type">size_t</span> *outlen</code></em>,
                        <em class="parameter"><code><span class="type">size_t</span> *outprespace</code></em>);</pre>
<p>Completes the filtering.</p>
<div class="refsect3">
<a name="g-mime-filter-complete.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filter</p></td>
<td class="parameter_description"><p>filter</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>inbuf</p></td>
<td class="parameter_description"><p>input buffer. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=inlen][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> guint8]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>inlen</p></td>
<td class="parameter_description"><p>input buffer length</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prespace</p></td>
<td class="parameter_description"><p>prespace buffer length</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>outbuf</p></td>
<td class="parameter_description"><p>pointer to output buffer. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=outlen][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> guint8][<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>outlen</p></td>
<td class="parameter_description"><p>pointer to output length. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>outprespace</p></td>
<td class="parameter_description"><p>pointer to output prespace buffer length. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-filter-reset"></a><h3>g_mime_filter_reset ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_filter_reset (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>);</pre>
<p>Resets the filter.</p>
<div class="refsect3">
<a name="g-mime-filter-reset.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>filter</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-filter-backup"></a><h3>g_mime_filter_backup ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_filter_backup (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>,
                      <em class="parameter"><code>const <span class="type">char</span> *data</code></em>,
                      <em class="parameter"><code><span class="type">size_t</span> length</code></em>);</pre>
<p>Sets number of bytes backed up on the input, new calls replace
previous ones</p>
<div class="refsect3">
<a name="g-mime-filter-backup.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filter</p></td>
<td class="parameter_description"><p>filter</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>data to backup. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=length][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> guint8]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>length</p></td>
<td class="parameter_description"><p>length of <em class="parameter"><code>data</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-filter-set-size"></a><h3>g_mime_filter_set_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_filter_set_size (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>,
                        <em class="parameter"><code><span class="type">size_t</span> size</code></em>,
                        <em class="parameter"><code><span class="type">gboolean</span> keep</code></em>);</pre>
<p>Ensure this much size is available for filter output (if required)</p>
<div class="refsect3">
<a name="g-mime-filter-set-size.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filter</p></td>
<td class="parameter_description"><p>filter</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>requested size for the output buffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>keep</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if existing data in the output buffer should be kept</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GMimeFilter.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GMimeFilter-struct"></a><h3>struct GMimeFilter</h3>
<pre class="programlisting">struct GMimeFilter;</pre>
<p>Base class for filters used by <a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a>.</p>
<div class="refsect3">
<a name="GMimeFilter.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GMimeFilter.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>